There are four types of results to use for zonal recognition. All are derived from the Result object. These result types are described below along with their supported methods and properties.
Result
This is the base object within which all other result objects are defined. Within this object you can get the properties of a result.
The three main properties that are included in all results are:
Property | Description |
Area | The rectangular area of the result object on the image. This area provides information on where the recognized text was located. |
Confidence | The value which represents how closely the recognition engine was able to match the image contents to a possible result. |
Text | The text string of one or more characters of the result. |
CharacterResult
This object is derived from the Result object. It represents recognition of a single character. Most of the properties in this object are read-only.
Method | Description |
AlternateConfidence | This method allows you to return an alternate confidence value based on a given index. |
AlternateText | This method allows you to return an alternate text string based on a given index value. |
Property | Description |
Area | The rectangular coordinates that define the CharacterResult on the image. This area is the Rectangle object which is made up of four coordinates which include the height, width, x and y positions on the image. |
Confidence | The value which represents how closely the recognition engine was able to match the image contents to a possible result. |
NumberResults | The number of alternate results in the character result. |
Text | The text string of the character result. To correct the value of a character result, this property can be set as needed. |
TextLineResult
This object is derived from the Result object. It is used for text line recognition results. The properties in this object are read-only.
Method | Description |
Character | Gets the CharacterResult for the given index within the TextLineResult. |
DeleteCharacter | Deletes the CharacterResult for given index within the TextLineResult. |
Property | Description |
Area | The rectangular coordinates that define the coordinates of the TextLineResult. This area is the Rectangle object which is made up of four coordinates which include the height, width, x and y positions on the image. |
Confidence | The value which represents how closely the recognition engine was able to match the elements of the image contents defined by the text line to a possible result. |
NumberCharacters | The number of characters within the TextLineResult. |
TextBlockResult
This object is derived from the Result object. It is used for text block recognition results. The properties in this object are read-only.
Method | Description |
DeleteTextLine | Deletes the TextLineResult for the given index within the TextBlockResult. |
TextLine | Allows you to access the TextLineResult that corresponds to the given index within the TextBlockResult. |
Property | Description |
Area | The rectangular coordinates that define the coordinates of the TextBlockResult. This area is the Rectangle object which is made up of four coordinates which include the height, width, x and y positions on the image. |
Confidence | The value which represents how closely the recognition engine was able to match the elements of the image contents defined by the text block to a possible result. |
NumberTextLines | The number of text lines that are contained in the TextBlockResult. |
Text | The text string of characters which make up the TextBlockResult. |
Better results may be obtained by proper image processing, good segmentation and setting recognition, character sets, and, if applicable, field types and/or data validation lists correctly.